Add server stream events #2068
Closed
Add server stream events #2068
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Motivation: As a service author it's useful to know if the underlying stream has been cancelled (because it's timed out, the remote peer closed it, the connection dropped etc). For cases where the stream has already closed this can be surfaced by a read or write failing. However, for cases like server-streaming RPCs where there are no reads and writes can be infrequent it's useful to have a more explicit signal. Modifications: - Add a `ServerStreamState` which provides two API for this: - An explicit "has this RPC been cancelled?" - An async sequence of events which can happen the underlying stream - Add the stream state to the server context - Update the in-process transport to use this Result: Server context includes a way for users to know if their RPC has been cancelled.
glbrntt
commented
Sep 23, 2024
| import Synchronization | ||
|
|
||
| @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *) | ||
| public struct ServerStreamState: Sendable { |
There was a problem hiding this comment.
For discussion: I don't like this name.
The other idea I had was ServerStreamContext which is potentially better and aligns with ServerContext. Downside is that it hints at a slightly wide use.
Another option: rather than nesting Events have a ServerStreamEvents type which also has a computed property for isRPCCancelled (i.e. an AsyncSequence with extra API).
|
Closing in favour of #2090 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation:
As a service author it's useful to know if the underlying stream has been cancelled (because it's timed out, the remote peer closed it, the connection dropped etc).
For cases where the stream has already closed this can be surfaced by a read or write failing. However, for cases like server-streaming RPCs where there are no reads and writes can be infrequent it's useful to have a more explicit signal.
Modifications:
ServerStreamStatewhich provides two API for this:Result:
Server context includes a way for users to know if their RPC has been cancelled.